get_list_position

audio_form object

This method will return the position of the cursor in a listbox.

int get_list_position(int control_id)

Parameters:
control_id
The control ID of the listbox.

Return value:
The cursor position on success, -1 on failure or if the cursor is not focused on a value.

Remarks:
This is useful for acting based on the item that is currently highlighted on the listbox in question.

Please note that the position does not need to be manually set, since the audio_form class changes the position automatically when different items are selected.

Example:

// Make a simple form with a few buttons and a listbox.

#include "form.bgt"

audio_form form;

void main()
{
form.create_window("Example Form", true);
int list=form.create_list("&People", 0);
form.add_list_item(list, "Joseph", -1);
form.add_list_item(list, "Samuel", -1);
form.add_list_item(list, "Percival", 1);
form.add_list_item(list, "William", -1);
form.add_list_item(list, "Edward", 0);
int ok=form.create_button("OK");
int cancel=form.create_button("E&xit");
while(true)
{
form.monitor();
wait(5);
if(form.is_pressed(ok))
{
alert("Information", "The listbox cursor is at position "+form.get_list_position(list));
exit();
}
if(form.is_pressed(cancel))
{
exit();
}
if((key_down(KEY_LMENU))&&(key_pressed(KEY_F4)))
{
exit();
}
}
}